<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Get follower stats API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'ccr-get-follow-stats.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-get-follow-stats.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/ccr-get-follow-stats.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/ccr-get-follow-stats.html" rel="nofollow" target="_blank">../en/ccr-get-follow-stats.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="ccr-apis.html">Cross-cluster replication APIs</a></span>
»
<span class="breadcrumb-node">Get follower stats API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="ccr-post-forget-follower.html">« Forget follower API</a>
</span>
<span class="next">
<a href="ccr-get-follow-info.html">Get follower info API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="ccr-get-follow-stats"></a>Get follower stats API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Get follower stats.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /&lt;index&gt;/_ccr/stats</pre>
</div>
<div class="console_widget" data-snippet="snippets/1438.console"></div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
If the Elasticsearch security features are enabled, you must have <code class="literal">monitor</code> cluster
privileges on the cluster that contains the follower index. For more information,
see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API gets follower stats. This API will return shard-level stats about the
following tasks associated with each shard for the specified indices.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-path-parms"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;index&gt;</code>
</span>
</dt>
<dd>
(Required, string) A comma-delimited list of index patterns.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API returns the following information:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices</code>
</span>
</dt>
<dd>
(array) An array of follower index statistics.
</dd>
</dl>
</div>
<p>The <code class="literal">indices</code> array consists of objects containing two fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].index</code>
</span>
</dt>
<dd>
(string) The name of the follower index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards</code>
</span>
</dt>
<dd>
(array) An array of shard-level following task statistics.
</dd>
</dl>
</div>
<p>The <code class="literal">shards</code> array consists of objects containing the following fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].shards[].remote_cluster</code>
</span>
</dt>
<dd>
(string) The <a class="xref" href="modules-remote-clusters.html" title="Remote clusters">remote cluster</a> containing the leader
index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].leader_index</code>
</span>
</dt>
<dd>
(string) The name of the index in the leader cluster being followed.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_index</code>
</span>
</dt>
<dd>
(string) The name of the follower index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].shard_id</code>
</span>
</dt>
<dd>
(integer) The numerical shard ID, with values from 0 to one less than the
number of replicas.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].leader_global_checkpoint</code>
</span>
</dt>
<dd>
(long) The current global checkpoint on the leader known to the follower task.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].leader_max_seq_no</code>
</span>
</dt>
<dd>
(long) The current maximum sequence number on the leader known to the follower
task.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_global_checkpoint</code>
</span>
</dt>
<dd>
(long) The current global checkpoint on the follower. The difference between the
<code class="literal">leader_global_checkpoint</code> and the <code class="literal">follower_global_checkpoint</code> is an
indication of how much the follower is lagging the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_max_seq_no</code>
</span>
</dt>
<dd>
(long) The current maximum sequence number on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].last_requested_seq_no</code>
</span>
</dt>
<dd>
(long) The starting sequence number of the last batch of operations requested
from the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].outstanding_read_requests</code>
</span>
</dt>
<dd>
(integer) The number of active read requests from the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].outstanding_write_requests</code>
</span>
</dt>
<dd>
(integer) The number of active bulk write requests on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].write_buffer_operation_count</code>
</span>
</dt>
<dd>
(integer) The number of write operations queued on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_mapping_version</code>
</span>
</dt>
<dd>
(long) The mapping version the follower is synced up to.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_settings_version</code>
</span>
</dt>
<dd>
(long) The index settings version the follower is synced up to.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_aliases_version</code>
</span>
</dt>
<dd>
(long) The index aliases version the follower is synced up to.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].total_read_time_millis</code>
</span>
</dt>
<dd>
(long) The total time reads were outstanding, measured from the time a read
was sent to the leader to the time a reply was returned to the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].total_read_remote_exec_time_millis</code>
</span>
</dt>
<dd>
(long) The total time reads spent executing on the remote cluster.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].successful_read_requests</code>
</span>
</dt>
<dd>
(long) The number of successful fetches.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].failed_read_requests</code>
</span>
</dt>
<dd>
(long) The number of failed reads.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].operations_read</code>
</span>
</dt>
<dd>
(long) The total number of operations read from the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].bytes_read</code>
</span>
</dt>
<dd>
<p>
(long) The total of transferred bytes read from the leader.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>This is only an estimate and does not account for compression if enabled.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].total_write_time_millis</code>
</span>
</dt>
<dd>
(long) The total time spent writing on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].write_buffer_size_in_bytes</code>
</span>
</dt>
<dd>
(long) The total number of bytes of operations currently queued for writing.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].successful_write_requests</code>
</span>
</dt>
<dd>
(long) The number of bulk write requests executed on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].failed_write_requests</code>
</span>
</dt>
<dd>
(long) The number of failed bulk write requests executed on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].operations_written</code>
</span>
</dt>
<dd>
(long) The number of operations written on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions</code>
</span>
</dt>
<dd>
(array) An array of objects representing failed reads.
</dd>
</dl>
</div>
<p>The <code class="literal">read_exceptions</code> array consists of objects containing the following
fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions[].from_seq_no</code>
</span>
</dt>
<dd>
(long) The starting sequence number of the batch requested from the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions[].retries</code>
</span>
</dt>
<dd>
(integer) The number of times the batch has been retried.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions[].exception</code>
</span>
</dt>
<dd>
(object) Represents the exception that caused the read to fail.
</dd>
</dl>
</div>
<p>Continuing with the fields from <code class="literal">shards</code>:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].shards[].time_since_last_read_millis</code>
</span>
</dt>
<dd>
<p>
(long) The number of milliseconds since a read request was sent to the leader.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>When the follower is caught up to the leader, this number will
  increase up to the configured <code class="literal">read_poll_timeout</code> at which point another read
  request will be sent to the leader.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">indices[].fatal_exception</code>
</span>
</dt>
<dd>
(object) An object representing a fatal exception that cancelled the following
task. In this situation, the following task must be resumed manually with the
<a class="xref" href="ccr-post-resume-follow.html" title="Resume follower API">resume follower API</a>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-examples"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This example retrieves follower stats:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /follower_index/_ccr/stats</pre>
</div>
<div class="console_widget" data-snippet="snippets/1439.console"></div>
<p>The API returns the following results:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "indices" : [
    {
      "index" : "follower_index",
      "shards" : [
        {
          "remote_cluster" : "remote_cluster",
          "leader_index" : "leader_index",
          "follower_index" : "follower_index",
          "shard_id" : 0,
          "leader_global_checkpoint" : 1024,
          "leader_max_seq_no" : 1536,
          "follower_global_checkpoint" : 768,
          "follower_max_seq_no" : 896,
          "last_requested_seq_no" : 897,
          "outstanding_read_requests" : 8,
          "outstanding_write_requests" : 2,
          "write_buffer_operation_count" : 64,
          "follower_mapping_version" : 4,
          "follower_settings_version" : 2,
          "follower_aliases_version" : 8,
          "total_read_time_millis" : 32768,
          "total_read_remote_exec_time_millis" : 16384,
          "successful_read_requests" : 32,
          "failed_read_requests" : 0,
          "operations_read" : 896,
          "bytes_read" : 32768,
          "total_write_time_millis" : 16384,
          "write_buffer_size_in_bytes" : 1536,
          "successful_write_requests" : 16,
          "failed_write_requests" : 0,
          "operations_written" : 832,
          "read_exceptions" : [ ],
          "time_since_last_read_millis" : 8
        }
      ]
    }
  ]
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="ccr-post-forget-follower.html">« Forget follower API</a>
</span>
<span class="next">
<a href="ccr-get-follow-info.html">Get follower info API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>